/*
 * Copyright 2002-2007 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the
 * License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */

package com.powersi.hygeia.framework.spring;

import org.springframework.jdbc.core.JdbcTemplate;

/**
 * Object to represent a SQL parameter value, including parameter metadata such as the SQL type and the scale for numeric values.
 * 
 * <p>
 * Designed for use with {@link JdbcTemplate}'s operations that take an array of argument values: Each such argument value may be a
 * <code>SqlParameterValue</code>, indicating the SQL type (and optionally the scale) instead of letting the template guess a default type. Note that this only
 * applies to the operations with a 'plain' argument array, not to the overloaded variants with an explicit type array.
 * 
 * @author Juergen Hoeller
 * @since 2.0.5
 * @see java.sql.Types
 */
public class SqlParameterValue extends SqlParameter {

    private final Object value;

    /**
     * Create a new SqlParameterValue, supplying the SQL type.
     * 
     * @param sqlType
     *            SQL type of the parameter according to <code>java.sql.Types</code>
     * @param value
     *            the value object
     */
    public SqlParameterValue(int sqlType, Object value) {
        super(sqlType);
        this.value = value;
    }

    /**
     * Create a new SqlParameterValue, supplying the SQL type.
     * 
     * @param sqlType
     *            SQL type of the parameter according to <code>java.sql.Types</code>
     * @param typeName
     *            the type name of the parameter (optional)
     * @param value
     *            the value object
     */
    public SqlParameterValue(int sqlType, String typeName, Object value) {
        super(sqlType, typeName);
        this.value = value;
    }

    /**
     * Create a new SqlParameterValue, supplying the SQL type.
     * 
     * @param sqlType
     *            SQL type of the parameter according to <code>java.sql.Types</code>
     * @param scale
     *            the number of digits after the decimal point (for DECIMAL and NUMERIC types)
     * @param value
     *            the value object
     */
    public SqlParameterValue(int sqlType, int scale, Object value) {
        super(sqlType, scale);
        this.value = value;
    }

    /**
     * Create a new SqlParameterValue based on the given SqlParameter declaration.
     * 
     * @param declaredParam
     *            the declared SqlParameter to define a value for
     * @param value
     *            the value object
     */
    public SqlParameterValue(SqlParameter declaredParam, Object value) {
        super(declaredParam);
        this.value = value;
    }

    /**
     * Return the value object that this parameter value holds.
     */
    public Object getValue() {
        return this.value;
    }

}
